home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / boot / czesc_2 / wiconify / wiconsetter.lzh / wIconCutter / wIconCutter.doc < prev    next >
Text File  |  1991-04-19  |  6KB  |  137 lines
  1. OVERVIEW:
  2.  
  3. WICONCUTTER is a companion program to WICONIFY and WICONSETTER.  It allows
  4. you to select a region on any screen and converts it to an icon file ready
  5. for use with wIconSetter.  wIconCutter can produce IMAGE, SELECT and MASK
  6. data for icons, and can combine this information with existing files, or
  7. create new icon files.
  8.  
  9.  
  10. HOW TO USE WICONCUTTER:
  11.  
  12. To start wIconCutter, simply issue the wIconCutter command at a CLI prompt:
  13.  
  14.     1> WICONCUTTER  filename
  15.  
  16. where 'filename' is replaced by the name of the icon file that you want to
  17. create.  wIconCutter will erase any old file by this name, so be careful
  18. that you use the correct name.
  19.  
  20. Once wIconCutter is installed, it will give a brief message to that effect,
  21. and you can choose the area you want to convert to an icon.  Simply select
  22. the screen that contains the imagery you want to use, and when you are ready
  23. to cut it, hold down the SHIFT key and drag a rectangular select box that
  24. encloses the image you want.  When you let go of the left button,
  25. wIconCutter will write the icon file.
  26.  
  27. Since you have to be holding down the SHIFT key to begin the selection
  28. process, you can still use the left button for selecting screens, depth
  29. arranging windows, etc, even after wIconCutter is running.  Just don't hold
  30. down SHIFT until you are ready to start the selection.
  31.  
  32. If you decide that you don't want to make an icon after all (or if you have
  33. give the wrong file name), simply press CTRL-C instead of starting a selection.
  34. You may press CTRL-C to cancel wIconCutter even after you have started
  35. dragging; just be sure to do it while you are still holding the left mouse
  36. button down.  Once you let go of the left mouse button, wIconCutter will begin
  37. to write the icon file.
  38.  
  39. Once you have begun a selection, you may decide that the box is not in the
  40. correct position.  In this case, you can hold down the right mouse button
  41. while you are dragging the box (i.e., without letting go of the left
  42. button); now when you move the mouse, the box will change location rather
  43. than size.  When you let go of the right button (while still holding the
  44. left down), you can continue to size the selection box as normal.  This
  45. gives you very precise control of the position and size of the selection as
  46. you make it.
  47.  
  48. Note that the selected image includes the pixels that are part of the
  49. selection frame itself.  For example, if you push the selection box all the
  50. way to the upper left, your selection will start at the very first pixel of
  51. the very first row of the screen.
  52.  
  53. wIconCutter was designed to clip relatively small sections of screen, so you
  54. should not use it to make icons larger than say 100 x 100 pixels (wIconify
  55. doesn't want icons larger than 78 by 32 anyway).
  56.  
  57.  
  58. WICONCUTTER OPTIONS:
  59.  
  60. There are a number of command-line options that you can specify when you
  61. start wIconCutter.  They include:
  62.  
  63.     IMAGE           create an IMAGE command and its data
  64.     SELECT          create a SELECT command and its data
  65.     MASK            create a MASK command and its data
  66.     APPEND          append the command to a file rather than rewrite it
  67.     PLANES n        select the bit-planes to include in the image
  68.  
  69. The default action is to create a new file with an IMAGE command.  You may
  70. specify IMAGE and MASK together, or SELECT and MASK (or even IMAGE, SELECT
  71. and MASK all at once), in which case the commands and data will be written
  72. for both or all three types of images.
  73.  
  74. The mask bits are simply the logical OR of all the bits in the image.  That
  75. is, for any given pixel position within the image, the mask bit is 0 if the
  76. pen color at that position was 0 and is 1 otherwise.  Note that this means
  77. that color-0 pixels that are interior to the image will NOT be included
  78. (as 1's) in the image mask.  For example, if you clip the following image:
  79.  
  80.       22222222222222222222222
  81.       00220000000002211112200
  82.       00220000000002211112200
  83.       00220000000002211112200
  84.       22222222222222222222222
  85.  
  86. the image mask would be:
  87.  
  88.       11111111111111111111111
  89.       00110000000001111111100
  90.       00110000000001111111100
  91.       00110000000001111111100
  92.       11111111111111111111111
  93.  
  94.  
  95. You might wish to modify the mask by hand to become
  96.  
  97.       11111111111111111111111
  98.       00111111111111111111100
  99.       00111111111111111111100
  100.       00111111111111111111100
  101.       11111111111111111111111
  102.  
  103. if you wanted to include the interior color-0 pixels as part of the image.
  104.  
  105.  
  106. The APPEND option is convenient for adding a SELECT image to an icon that
  107. already has an IMAGE, or a MASK to one that has an IMAGE or SELECT image.
  108. If you do NOT specify APPEND, wIconCutter will REPLACE the icon file, if it
  109. already exists.
  110.  
  111.  
  112. The PLANES option lets you select only a few of the bitplanes from a multi-
  113. plane image.  The number that follows the PLANES option is a Hex value that
  114. represents PlanePick mask similar to the ones used in the Intuition Image
  115. structure:  wherever ther is a 1 in the binary representation of the
  116. PlanePick number, that bitplane is included in the image; where there's a 0,
  117. that plane is ignored.
  118.  
  119.  
  120. WARNING:
  121.  
  122. wIconCutter currently looks in the Intuition private area of the
  123. IntuitionBase structure in order to find the mouse movement limits.  It is
  124. likely that this will cause wIconCutter to fail in a future version of
  125. Intuition.  In this case, a re-compile may be all that's necessary; if not,
  126. the Intuition private lookup appears in only one part of the code, and it
  127. can be modified if needed.
  128.  
  129.  
  130. AUTHOR:
  131.  
  132. Davide P. Cervone
  133. Mathematics Department
  134. Brown University
  135. Providence, Rhode Island 02912
  136. ST402523@BROWNVM
  137.